home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / g_quake / compv09b.zip / C.TXT < prev    next >
Text File  |  1996-09-28  |  12KB  |  297 lines
  1.                                     
  2.                                    
  3.                             Quake Level Compiler:
  4.                                    Compile
  5.                         version 0.9 (beta, of course)
  6.  
  7.  
  8. 1.....What is Compile?
  9.  1.1...What do I need to run Compile?
  10.  
  11. 2.....Why should I use Compile?
  12.  2.1...Why was Compile written?
  13.  2.2...What operating systems does Compile run under?
  14.  2.3...Why is Compile a DOS *batch* file? Are you nuts??
  15.  2.4...Why isn't there a cool logo in this manual?
  16.  
  17. 3.....How do I use Compile?
  18.  3.1...What can Compile do?
  19.  3.2...Which commands do what?
  20.  3.3...Why don't my command work?  aka  The program! It is messing up!
  21.  3.4...Why am I getting errors?
  22.  
  23. 4.....How do I contact the author?
  24.  4.1...WHY should I contact the author?
  25.  4.2...Where do I submit a bug report?
  26.  4.3...Why can't I do...?
  27.  4.4...Where do I suggest features?
  28.  
  29. 5.....Legal stuff
  30.  
  31.  
  32.  
  33.                                 
  34.                                 Section 1
  35.  
  36. 1.....What is Compile?
  37.       
  38.       Compile is a "shell" for QBSP, LIGHT and VIS. Simply put, it compiles
  39. levels for you. You can either run it with all the default values, or set every
  40. option manually. You can also compile a whole bunch of maps in one big chunk,
  41. letting you leave the computer unattended for a long time (hell, we all know
  42. that compiling levels is no quick process). Compile is a DOS batch file; for
  43. those of you who don't know what that is, it's a series of DOS commands stored
  44. in a text file. Primitive but effective.
  45.  
  46.  
  47.  
  48. 1.1...What do I need to run Compile?
  49.  
  50.         What you need to run Compile is simple; the trio of QBSP.EXE, LIGHT.EXE
  51. and VIS.EXE (the three id level-compiling utils). They're available at
  52. ftp.cdrom.com/pub/quake/utils/level_editing/bsp_builders, and take up about
  53. 250k, compressed. Also, a texture WAD format file will come in handy. NO, not
  54. a Doom WAD file, a Quake texture WAD file. You can find a ton of those on the
  55. net - try exploring ftp.cdrom.com/pub/quake, you should find a few. Or mail me
  56. (see 4 - contacting the author. I'm too lazy to write out my e-mail address
  57. twice. Oh, ok - it's zenin@m5.sprynet.com) and ask for one, I've got a few.
  58.  
  59.  
  60.                                 
  61.                                 Section 2
  62.                                 
  63.  
  64. 2.....Why should I use Compile?
  65.  
  66.         Well, actually - you really don't have too. Compile is just something
  67. to make life easier and simpler for Quake editing freaks (for anyone who really
  68. IS, that's not an insult). But here's a list of reasons anyways:
  69.  
  70.  -* Can compile a list of up to nine levels at a time (tested), maybe more
  71.  -* You don't have to worry about waiting a few hours to vis a level, then
  72.      running light manually - it's all done in series.
  73.  -* Small size. Hell, I'm not done writing this manual yet, and when it's done
  74.      it'll probably be bigger than the actual executable.
  75.  -* The best support on the net (well, maybe not quite). Quite frankly, I don't
  76.      have anything better to do - if you've got a problem, mail me and I'll
  77.      either explain it or fix it.
  78.  -* And the best reason of all, because - at heart - we're all lazy. Take
  79.      advantage of simplicity! Use Compile! Maybe I can get my own informercial.
  80.  
  81.  
  82.  
  83. 2.1...Why was Compile written?
  84.  
  85.         Actually, I still don't quite know. I had a simple batch file running,
  86. that'd accept a couple of simple parameters. I decided to add support for all
  87. the options in all of the programs. Simply put, one friday afternoon I was
  88. bored. Great origins, eh? Well, hope it's useful.
  89.  
  90.  
  91.  
  92. 2.2...What operating systems does Compile run under?
  93.  
  94.         Compile is a DOS batch file, so it probably runs only under DOS. It
  95. does not work well under Windows 3.x (not tested, 'cuz I can almost predict the
  96. results. Don't bother), probably not under Win95/NT either. I don't have access
  97. to a UNIX system or variants thereof, but chances are that it won't work there
  98. either. To put it simply - run it in DOS mode. Sorry. I use DOS. One of these
  99. days, I'll switch - but not today.
  100.  
  101.  
  102.  
  103. 2.3...Why is Compile a DOS *batch* file? Are you nuts??
  104.  
  105.         Well, there are a few reasons. One, batch files are tiny. I mean really
  106. small. Two, batch files almost NEVER get virii (plural of virus, I guess),
  107. mainly because they're too primitive. Three, batch files are easily editable -
  108. any user with a brain and a text editor can mess around with it. Four, no
  109. compilers are needed to let the baby rip. Five, I can't write C/C++ yet. But
  110. seriously, why waste time writing up a really wicked program when a simple one
  111. will do? I could've done a nice graphical menu and stuff (yes, that can be done
  112. in batch. If you don't beleive me, ask me for an example. I've written three or
  113. four already), but honestly, it only would've slowed things down.
  114.  
  115.  
  116.  
  117. 2.4...Why isn't there a cool logo in this manual?
  118.  
  119.         Gimme a break, OK (grin)? I don't want to start out with a BUAF (big
  120. ugly ASCII font), and besides, I don't think it's really necessary. But if
  121. enough people (like, more than zero) want it in, I'll paste one in for the next
  122. release. But I don't think anyone'll want one.
  123.  
  124.  
  125.                                 
  126.                                 Section 3
  127.  
  128.                                 
  129. 3.....How do I use Compile?
  130.          
  131.          Okay, now we get into the more complicated part. Compile accepts a lot
  132. of parameters (bit of trivia - almost the whole program is a command line
  133. parser. The actual compiling "meat", the part that calls the compiler programs,
  134. is only three lines long). You can get a list of all the accepted parameters in
  135. section 3.2, "Which commands do what?". But basically, the format is this:
  136.  
  137. C:\QUAKE\LEVELS\COMPILER\compile mymap
  138.  
  139. Don't put in any extensions. That'll mess stuff up, unless you only want to run
  140. QBSP. A more complex command line would run thus:
  141.  
  142. C:\QUAKE\LEVELS\COMPILER\compile vis -fast light -extra mymap
  143.  
  144. OK, what that'll do is set QBSP to run normally, then set vis to run with the
  145. -fast parameter, then set light to run with the -extra parameter, and then run
  146. all three programs on mymap.map. Things to remember: all commands MUST be set
  147. before you start listing map names; to set commands for a program, put the
  148. program name on the command line (qbsp, vis, or light) followed by the
  149. parameter to be passed to it; all commands that are mispelled will result in
  150. everything after the mispelled command to be treated as map names (that's NOT a
  151. good thing); and all commands must be spelled either all in capitals or all in
  152. lowercase, no mixed cases.
  153.  
  154.  
  155.  
  156. 3.1...What can Compile do?
  157.  
  158.         Compile can compile up to, and maybe more than, nine maps - one after
  159. another. Any maps with errors in them will be messed up, but will leave the
  160. following unaffected. Compile can set all parameters for qbsp, light and vis.
  161. Compile can do your taxes, improve your love life, guarantee instant happiness,
  162. and speak the time and date via mental telepathy to everyone withing a five
  163. foot radius - well, maybe not.
  164.  
  165.  
  166.  
  167. 3.2...Which commands do what?
  168.  
  169.         Compile supports all the parameters for qbsp, light and vis. Those are:
  170.  
  171. QBSP:   -draw...............(unknown)
  172.         -notjunc............(unknown)
  173.         -nofill.............(unknown)
  174.         -noclip.............(unknown)
  175.         -onlyents...........(only process entities - not architectural changes)
  176.         -verbose............(produce more informational output)
  177.         -usehulls...........(unknown)
  178.         -proj <projectpath>.(save bsp file to an alternate directory)
  179.  
  180. LIGHT:  -threads num........(unknown, but replace num with 1-4)
  181.         -extra..............(extra quality mode, takes approx. 4x long)
  182.  
  183. VIS:    -threads #..........(unknown, but replace with 1-4)
  184.         -level 0-4..........(vis level: 1=lowest/worst/fastest,
  185.                              4=highest/best/slowest)
  186.         -fast...............(fast vis. Low quality, MUCH quicker than normal.
  187.                              Don't use -fast if you use -level, and vice versa)
  188.         -v..................(unknown)
  189.  
  190.  
  191. To pass parameters to one of the three programs, simply put the name of the
  192. program on the command line, followed by the parameters to be passed. i.e.:
  193.  
  194. C:\QUAKE\LEVELS\COMPILER\compile vis -fast light -extra mymap mymap2 mymap3
  195.  
  196. or
  197.  
  198. C:\QUAKE\LEVELS\COMPILER\compile qbsp -onlyents -proj c:\quake\id1\maps vis
  199. -level 4 light -extra mymap mymap2 mymap3
  200.  
  201. Remember, map names must come LAST on the command line. Oh, and if you're
  202. worried about why there are so many unkown parameters, don't. They're no
  203. trouble, and normally not even used.
  204.  
  205.                                    
  206.  
  207. 3.3...Why don't my command work?  aka  The program! It is messing up!
  208.  
  209.         Hmmm... This is a strange problem, if it ever occurs. Well, maybe you
  210. mispelled the command? Maybe you wrote in mixed capital letters and lowercase?
  211. Maybe you ran out of environment space? Ok, well, there's three things to try:
  212.  
  213. 1. Look over the commands you typed in. Spelling mistakes can wreak havoc.
  214.    Remember not to mix capital letters and lowercase - be consistent.
  215.  
  216. 2. Type "command /e:1024" at the command line, and then run compile. That might
  217.    solve the problem.
  218.  
  219. 3. Put that gun away, and e-mail me with the specifics of your problem. I'll
  220.    fix it for you.
  221.  
  222.  
  223.  
  224. 3.4...Why am I getting errors?
  225.  
  226.         Hmm. For this, you really will have to mail me. Are the errors coming
  227. from qbsp, light or vis, or are they stemming from Compile itself? There are a
  228. lot of things that can go wrong (actually, when you step back and look at a
  229. computer, and think about all the things that CAN go wrong - it's a wonder that
  230. anything works at all). If you come up with reproducable bug, I'll fix it and
  231. put your name in the credits. I'd appreciate any input or feedback.
  232.  
  233.  
  234.  
  235.                                 Section 4
  236.  
  237.  
  238. 4.....How do I contact the author?
  239.  
  240.         Well, the easiest and fastest way to contact me is via internet e-mail.
  241. My address is zenin@m5.sprynet.com. I check my mail two or three times a day,
  242. sometimes even more than that, so prompt replies should be expected. And if you
  243. think I'm going to give out my street address on the net, you're crazy (grin).
  244.  
  245.  
  246.  
  247. 4.1...WHY should I contact the author?
  248.  
  249.         Well, if you have discovered a bug, or think up a cool new feature, or
  250. are wondering why the heck I left out something that really needs to be put in,
  251. or I missed something in this manual, please contact me. I'd love to make this
  252. a great program for all to use. Oh, and if your suggestion or bug report in any
  253. way influences a future release, I'll put your name in the credits section.
  254. "w00p, how ereet," as sCary would say (big grin).
  255.  
  256.  
  257.  
  258. 4.2...Where do I submit a bug report?
  259.  
  260.         Well, just mail it to me. Make sure it can be reproduced, and tell me
  261. how. If it's fixable, I'll fix it. If it's not fixable, I'll still fix it -
  262. I'll just be in a worse mood when it's finished.
  263.  
  264.  
  265.  
  266. 4.3...Why can't I do...?
  267.  
  268.         The most probable cause is that I messed up somewhere, or that I left
  269. it out. There's a couple of features I thought of, but never implemented. So if
  270. you want to be able to do something, (all together now...) mail me. I'll stuff
  271. it in the next release and put you in the credits section.
  272.  
  273.  
  274.  
  275. 4.4...Where do I suggest features?
  276.  
  277.         Mail me. (I'm getting lazy here. You've heard it all before, I think).
  278. One last time, my e-mail address is zenin@m5.sprynet.com.
  279.  
  280.  
  281.  
  282.                                 Section 5
  283.  
  284.  
  285. 5.....Legal stuff
  286.  
  287.         This software is provided without ANY guarantees of any type, real or
  288. implied. By using the included peice of software, you accept any responsibility
  289. for any and all consequences subsequently occuring. This software is not
  290. copyrighted in any manner; you are free to modify it in any way you see fit,
  291. although if it is redistributed, you must contact the author to inform him of
  292. your actions. This file may be redistributed by any manner, electronic or
  293. manual, although permission must be requested from the author before
  294. redistribution may occur. This file MUST be included, in unaltered form, with
  295. the archive. By reading this text, you unconditionally accept all of the
  296. forementioned restrictions.
  297.